/*
 * Copyright (c) 2019, 2019, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.svm.core.thread;

import org.graalvm.nativeimage.IsolateThread;
import org.graalvm.nativeimage.c.struct.RawField;
import org.graalvm.nativeimage.c.struct.RawStructure;
import org.graalvm.word.PointerBase;

import com.oracle.svm.core.c.struct.PinnedObjectField;

/**
 * Holds the mutable state that is necessary for the execution of a {@linkplain NativeVMOperation}.
 * This is used in places where we can't allocate Java objects (e.g., when a garbage collection is
 * required).
 */
@RawStructure
public interface NativeVMOperationData extends PointerBase {
    @PinnedObjectField
    @RawField
    void setNativeVMOperation(NativeVMOperation value);

    @PinnedObjectField
    @RawField
    NativeVMOperation getNativeVMOperation();

    @RawField
    NativeVMOperationData getNext();

    @RawField
    void setNext(NativeVMOperationData value);

    @RawField
    IsolateThread getQueuingThread();

    @RawField
    void setQueuingThread(IsolateThread value);

    @RawField
    long getQueuingThreadId();

    @RawField
    void setQueuingThreadId(long currentThreadId);

    @RawField
    boolean getFinished();

    @RawField
    void setFinished(boolean value);
}
